home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 44 / Mac Magazin and MacEasy Magazine CD - Issue 44.iso / Magazin / Netzwerkspiele / Software / Spezielle Chat u. Server Softw. / QuakeFinder 1.5.1 Folder / Read Me - QuakeFinder < prev    next >
Text File  |  1998-04-15  |  22KB  |  530 lines
  1. QuakeFinder 1.5.1  Read Me
  2.     April 14, 1998
  3.       Author: Scott Kevill
  4.  
  5. QuakeFinder is $15 shareware. If you continue to use it, you must pay for it.
  6. Please support the shareware policy. Refer to the included How to Register document for instructions.
  7.  
  8.  
  9. What is QuakeFinder?
  10.  
  11. QuakeFinder is the easiest and fastest program for finding, and joining, Internet multiplayer Quake servers.
  12.  
  13.  
  14. What’s New?
  15.  
  16. Keep checking the QuakeFinder News web page for the latest information:
  17.     <http://www.curtin.edu.au/~scott/quakefinder/news/>
  18.  
  19. Registered users are notified of new versions of QuakeFinder.
  20.  
  21.     Version 1.5.1: (free upgrade for registered users)
  22.      • Default command-line parameters for Quake to use at startup can be specified
  23.      • The number of attempts on a server before timing out can be set
  24.      • A maximum of 4 server info windows will be opened in one hit to guard
  25.        against accidental double-clicks with many servers selected.
  26.  
  27.  
  28. Main Features
  29.  
  30.      • Slick user interface
  31.      • Smooth and responsive Macintosh feel
  32.      • Powerful and intuitive live filtering and sorting to sift through the hundreds of servers
  33.      • Incredibly fast!
  34.      • Extract new servers from web pages, text files, drag & drop, and the clipboard
  35.      • Automatically connect MacQuake to a server of your choice, optionally specifying
  36.        command-line parameters
  37.      • Effortlessly use custom Quake add-ons
  38.      • Easily manage lists of Master web sites for finding new servers
  39.      • See who is playing on a server and what their scores are
  40.  
  41.  
  42. Requirements
  43.  
  44.      • Power Macintosh
  45.      • System 7.5 or later
  46.      • Internet connection
  47.      • Quake for the Macintosh (version 1.08.3 or later)
  48.  
  49.  
  50. Introduction
  51.  
  52. Files
  53.  
  54. Files store the complete list of Quake servers, any custom lists, and any Master lists.
  55.  
  56. In the file window, one or more lists are shown. The Full List is always present.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. Double-clicking an item will open the list showing the servers within. See Servers below for more information.
  69.  
  70. A file saved as “Default” in the same folder as QuakeFinder will be opened when QuakeFinder starts up. (An example one is included).
  71.  
  72.  
  73. Lists
  74.  
  75. Lists represent views of the complete server list. The Full List is a special case that shows every server in the file. In addition you can create custom lists that are either non-filtered (a fixed favourites list) or filtered (dynamic and based on criteria). Every custom list is a subset of the Full List.
  76.  
  77. When you create a new list or choose Get Info on an existing list you are presented with a window for editing the attributes of the list. (You cannot Get Info on the Full List since it cannot be modified).
  78.  
  79. The info window for a non-filtered list looks like this:
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87. The info window for a filtered list looks like this:
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104. The List name: field is any name that you might want to give the list such as Favourites, Capture the Flag, or My Fast Servers, for example.
  105.  
  106. The Game: pop-up menu allows you to choose a modification to run Quake with when you join a server from this list. Modifications are add-ons often designed to enhance or change the style of game play in Quake. If the modification name is in italics, you don’t have the modification installed in your Quake directory or it is under a different name. See the Web Resources document included with QuakeFinder for where to download some of the common add-ons. The Troubleshooting section near the end of this document gives some tips if you are having difficulty getting an add-on to work.
  107.  
  108. The Non-filtered / Filtered radio buttons let you switch between list types.
  109.  
  110. With filtered lists you can assign criteria that will only show the servers that you are interested in. These are enabled via the checkboxes on the left side. A server will only be shown in the list if it satisfies all the enabled criteria.
  111.  
  112. The Response is less than criterion will only show servers whose response time is less than the given number of milliseconds. Anything less than 400ms is usually tolerable and anything less than 250ms is usually very playable. This is the way to list only the servers that are the most responsive to you.
  113.  
  114. The Server name criterion lets you list servers based on their name by matching with some given text. Note that servers aren’t required to follow any naming convention, but they often do. There are a number of options for matching the text:
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122. The Map name criterion filters servers based on the level or map they are currently playing. There are two types of matching, by kind and by name. By kind; a simple way of filtering whether or not the map is a style of id map (one that comes with Quake). By name, matches the map name with some given text and the same options as for the Server name are allowed.
  123.  
  124. The Player capacity is from criterion will list servers where the maximum number of players allowed is within a given range. Usually the number of players allowed in a Quake game varies between 2 and 16.
  125.  
  126. The Number of players is from criterion will list servers where the number of players currently in the game is a percentage of the capacity for each server within the given range.
  127.  
  128.  
  129. Servers
  130.  
  131. After opening a list a window appears showing the servers in that list.
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143. There are five columns of information:
  144.      - server name
  145.      - number of players / maximum player capacity
  146.      - IP address
  147.      - map name
  148.      - response time / number of retries
  149.  
  150. The servers are sorted by the darkened column. You can change the sorting key by clicking in the header of another column. The sorting order can be reversed by clicking the icon at the right of the headers or by clicking on a header that is already being sorted by.
  151.  
  152. If a server has question marks (?) in any of the columns then it needs to be refreshed. By telling QuakeFinder to refresh a server, the server is sent a message requesting information. The time taken for the information to be returned is the response time. The lower the better. If a server takes too long to respond (longer than 2 seconds), it is re-tried up to two more times and if it still hasn’t responded, it is skipped and Timeout is listed in its Response field. The number of retries or timeouts (if any) is listed after the time separated by a slash (/). Timeouts may indicate data loss along the way, or may just mean the server was busy changing levels. If a server is unreachable due to network errors or no Quake server running at that address, it is skipped and Down is listed in its Response field.
  153.  
  154. Even if there are no question marks, it is a good idea to periodically refresh the servers you are interested in so that the server information is up-to-date. Response times can vary a little, so if you have narrowed it down to deciding between a few servers, refresh them a few times to get an idea which one is the fastest overall.
  155.  
  156. The ‘chasing arrows’ in the top-left of the window will spin while servers are being refreshed so that you know something is happening. Refreshes can be aborted by pressing Cmd-Period or the Escape while a server list window is front-most.
  157.  
  158. Servers can be copied from one list to another by Copy and Paste or simply dragging the selected items into the other window. Servers can also be added by dragging any text onto a list to extract the server IP addresses from it.
  159.  
  160. More detailed information about a server can be obtained with the Get Info menu command (also double-click or press return). This will present a window with three tabbedpanes labelled Players, Game, and Rules. Note that this can sometimes take a few seconds to query all the information from the server. If you query server information at the same time as refreshing a server list, it may result in higher response times for the servers due to the extra data being transferred.
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174. The player list is similar in operation to a server list (you can change the sort columns and sorting order).
  175.  
  176. The Name can be displayed in a number of styles; see the description for the Preferences command under the Edit menu for more information. The name can be copied to the clipboard by selecting a player and choosing Copy from the Edit menu.
  177.  
  178. The number of Frags generally refers to the number of kills, but this can have different meanings with some add-ons.
  179.  
  180. The top colour bar for a player is the Shirt colour, and the bottom colour bar is the Pants (trousers) colour. On a server running team games, all members of a team have the same Pants colour so by sorting on Colour,  you can list all the teams’ members together.
  181.  
  182. The Time column is the amount of time a player has been connected to the server.
  183.  
  184. Note that with regular Quake, it is not possible to get the Ping times for individual players. This is only possible with QuakeWorld and Quake 2.
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198. The Game pane provides a nice summary of some miscellaneous information about the server. This is where you can find the DNS address and the port number (most regular Quake servers use port 26000). Choosing Copy from the Edit menu in this pane will copy the DNS address (or the IP address if none could be found) to the clipboard.
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212. The Rules pane provides some extra information about the currently playing game that may help you make a decision. Sometimes a server will have a cmdline rule that may indicate which add-on it is running. A rule Value may be copied to the clipboard by selecting the rule and choosing Copy from the Edit menu.
  213.  
  214. Masters
  215.  
  216. Masters are web pages that have lists of servers. When someone starts up a server that they plan to leave up for a while, they email the maintainers of these Master web pages. Their server then gets added to the lists on the web pages.
  217.  
  218. With each file in QuakeFinder you can keep a list of Masters. Each item is a URL for the web page, plus a more meaningful name that you can assign to it. Masters can then be ticked to select which ones will be used by QuakeFinder to find new servers and they will be queried one after the other. Hold down the option key while clicking to tick/untick all Masters.
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230. As with servers, ‘chasing arrows’ in the top-left of the window will spin while the Masters are being queried. If the word Error appears in the Status column for a Master, Get Info on it  (or double-click or press return) to see a more descriptive error message.
  231.  
  232. Master queries can be aborted by pressing Cmd-Period or the Escape key while the Masters window is front-most.
  233.  
  234.  
  235. Menus
  236.  
  237. Contextual menus are supported in MacOS 8 (and in System 7.x without requiring any extensions) in most windows for some common commands and can be activated by clicking with the Control key held down.
  238.  
  239. Apple Menu
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248. About QuakeFinder... displays the about box for QuakeFinder with the version number and the name of the registered user. You can click on the links to email Scott Kevill (the author) or visit the web site.
  249.  
  250. Register... lets you enter your name and registration serial number to register QuakeFinder.
  251.  
  252. Order Online... opens your web browser to the to Kagi where you can quickly and easily pay for QuakeFinder with your credit card. (See the accompanying How to Register document for instructions on registering including other methods of payment).
  253.  
  254.  
  255. File Menu
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270. New creates a new untitled file.
  271.  
  272. Open... loads an existing file.
  273.  
  274. Close closes the front-most window.
  275.  
  276. Save writes to disk any changes in the current file.
  277.  
  278. Save As... saves as a new file.
  279.  
  280. Revert restores the previously saved version of a file.
  281.  
  282. Import... searches through a text file and adds all the Quake servers it can find (as IP addresses) to the current file.
  283.  
  284. Export... saves all the servers in the current file out to a text file as a list of IP addresses.
  285.  
  286. Quit shouldn’t need any explanation!
  287.  
  288.  
  289. Edit Menu
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304. With the exception of Preferences... all the commands in the Edit menu apply to items in the front-most window. Depending on which window is front-most these items would be Lists, Masters or Servers.
  305.  
  306. Undo is always disabled since there are no operations that can be undone.
  307.  
  308. Cut removes the selected items and places them in the clipboard.
  309.  
  310. Copy places a copy of the selected items in the clipboard.
  311.  
  312. Paste pastes new items from the clipboard. If a server window is front-most you can paste any text and it will be searched for valid Quake servers (as IP addresses) to be added.
  313.  
  314. Clear removes the selected items. A shortcut is to press the delete key. In a non-filtered or ‘favourites’ server list this will remove the servers from that list only. In the full list or a filtered list this will completely remove the server from the current file.
  315.  
  316. Select All selects every item in the list.
  317.  
  318. Select None deselects every item in the list.
  319.  
  320. Get Server/List/Master Info... opens a window or dialog where you can edit the attributes of the selected items. You cannot get info on the Full List since that cannot be edited.
  321.  
  322. Preferences... shows a dialog that lets you change several options:
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345. If Warn before completely removing servers is checked QuakeFinder will confirm servers to be deleted with an alert (which can be bypassed by holding down the Option key).
  346.  
  347. The number of simultaneous server connections refers to the number of Quake servers queried at once. The higher this number the faster the server list is refreshed, but the less accurate the measured response times will be. A suitable value chosen for this usually depends on the speed of the internet connection you have. For PPP connections, the default, 10, is usually a good choice. For faster connections you may get away with higher values (the maximum is 20).
  348.  
  349. The number of attempts before timing out is the number of timeouts QuakeFinder will accept before giving up on a particular server. The lower the value is, the faster a full refresh will be (less time is wasted on servers that aren’t responding), but the more likely active servers will be missed (that were temporarily busy).
  350.  
  351. In the Use Game list, you can change which Quake application that QuakeFinder will launch. If no items are in the list then you may need to rebuild your desktop file. QuakeFinder cannot launch Quake for you if it cannot find it.
  352.  
  353. The Player Name Font selection lets you choose the style of text that player names are drawn with. Normal does a best effort using the standard Geneva font. Quake and Quake Double-Size both use the character set from within the game so all special characters are displayed accurately, the latter being more readable.
  354.  
  355. The Quake Startup Parameters field lets you specify command-line options that are run when Quake is launched to join a server. It is recommended that you use this rather than Quake’s method of remembering command-line options since Quake’s method will override any control QuakeFinder has over it. This can be turned on and off using the checkbox.
  356.  
  357.  
  358. List Menu
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365. Create New List... adds a new custom list. An info window will appear allowing you to edit the attributes of the newly created list.
  366.  
  367. View... opens the selected lists. This is the same as double-clicking or pressing return.
  368.  
  369.  
  370. Master Menu
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380. Return New Servers queries the enabled Masters for new servers. This doesn’t necessarily have to be done very often; just as often as you would want to be updated with new servers.
  381.  
  382. View Master List... shows the Masters list for the current file. Clicking in the tick column selectively enables or disables Masters.
  383.  
  384. Add Master... prompts you for a name and URL of a new Master to be added.
  385.  
  386. Open in Web Browser... takes you to the selected Master web page.
  387.  
  388.  
  389. Server Menu
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. Refresh Selected refreshes the selected servers in the front-most window. Make sure you regularly refresh the servers you are interested in, so you always have the current information. (See Servers above for more information).
  401.  
  402. Refresh <Current List> refreshes all the servers in the front-most window.
  403.  
  404. Refresh Full List refreshes all the servers in the file, regardless of which server list window is front-most.
  405.  
  406. Join... launches Quake with the modification chosen for the current list, connecting to the currently selected server. (See Preferences... under Edit Menu above for how to change which version of Quake is launched). You must have exactly one sever selected to use this. If the command is still greyed out, QuakeFinder probably cannot find your Quake applications. Again, see Preferences... under Edit Menu above if this happens.
  407.  
  408. Add Server... prompts you to add a server manually by entering the IP or DNS address (and optionally the port number). You can also add servers by simply pasting (or drag and drop) a chunk of text that contains IP addresses. Unlike the other methods of adding servers, this command allows you to specify any port number for the server. Note that Quake servers usually have the port number 26000. Servers with port numbers of around 27500 and 27910 are usually QuakeWorld and Quake 2 respectively; neither of which are currently supported by QuakeFinder since they are not yet available for the Macintosh.
  409.  
  410. If a server info window is frontmost, the Server menu will look like this:
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421. Refresh Server Info will refresh the player, rule, and game information for the server.
  422.  
  423. Refresh Players will refresh the player list only.
  424.  
  425. Refresh Rules will refresh the rule list only.
  426.  
  427. Refreshes can be aborted by pressing Cmd-Period or the Escape key.
  428.  
  429. Join… will connect Quake to the server as above.
  430.  
  431. Add Server… manually adds a new server as above (not related to the info window).
  432.  
  433.  
  434. Planned Features
  435.  
  436.      • QuakeWorld support
  437.      • Player search
  438.      • Auto-refreshes and Master queries (for example every # seconds or launches)
  439.  
  440.  
  441. Troubleshooting
  442.  
  443. The Join command in QuakeFinder is greyed out...
  444.  
  445. This usually means that QuakeFinder is unable to find Quake on your hard disk. Try rebuilding the desktop file by holding down the command and option keys as the Finder starts up. See Preferences... under Edit Menu above for choosing which Quake application QuakeFinder uses.
  446.  
  447. I can join Quake servers manually from within Quake, but when I try it with QuakeFinder, they just time out...
  448.  
  449. This is a symptom of earlier versions of Quake. Make sure you have version 1.08.3 or later. Visit
  450.     <http://www.wizworks.com/macsoft/mactech/quake.htm>
  451. for the latest version.
  452.  
  453. I try to join Quake servers from QuakeFinder, but Quake just starts normally into single player mode...
  454.  
  455. You have probably set Quake to always use a startup command line (hold Option as Quake launches), then disable it. This interferes with QuakeFinder’s control over Quake. You can achieve the same thing by setting the startup parameters in QuakeFinder’s Preferences dialog.
  456.  
  457. I can’t join any Quake servers at all...
  458.  
  459. This usually happens when you haven’t enabled TCP/IP in Quake. Choose Options... under the File menu, and then click the Multiplayer pane (the right-most one). Make sure the Enable TCP/IP box is checked.
  460.  
  461. Quake crashes when I try to join...
  462.  
  463. This is no fault of QuakeFinder, but here are some suggestions that have been known to help.
  464.  
  465.    • Make sure you have the latest version of Quake
  466.     <http://www.wizworks.com/macsoft/mactech/quake.htm>
  467.    • Disable any MacIPX extensions
  468.    • Try giving more memory to Quake
  469.    • Try trashing Quake's Preferences file
  470.  
  471. I can’t get my add-ons to run...
  472.  
  473. There can be a lot of reasons for this.
  474.  
  475.    • If the add-on folder was originally in .zip format, decompress it with Stuffit
  476.      Expander and make sure that the settings are to Never Convert Text Files to
  477.      Macintosh Format (in the Cross Platform preferences).
  478.  
  479.    • Make sure the folder has no spaces or slashes (/) in its name.
  480.  
  481.    • The folder should be placed inside your Quake folder along-side the Quake
  482.       applications.
  483.  
  484.    • Make sure your add-on folder is selected in the list you want to use it with in
  485.       QuakeFinder.
  486.  
  487.    • If you have set Quake to always use a startup command line (hold Option as
  488.       Quake launches), then disable it. This interferes with QuakeFinder’s control
  489.       over Quake. You can achieve the same thing by setting the startup parameters
  490.       in QuakeFinder’s Preferences dialog.
  491.   
  492.  
  493. Legal Details
  494.  
  495. QuakeFinder, its documentation, and artwork are copyright © 1997-1998 by Scott Kevill. All rights reserved.
  496.  
  497. QUAKE® is a registered trademark of id Software, Inc. QuakeFinder is not affiliated with or endorsed by id Software. Macintosh is a registered trademark of Apple Computer, Inc.
  498.  
  499. This archive may be freely distributed as long as it is kept intact and unmodified, and is not charged for (other than reasonable download costs). QuakeFinder may not be sold or bundled with any other product without my prior permission. QuakeFinder may not be included on any CD-ROM without my prior permission.
  500.  
  501. Users are prohibited from disclosing their registered serial numbers to anyone.
  502.  
  503. Scott Kevill hereby disclaims all warranties relating to this software, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose.  Scott Kevill will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason, even if Scott Kevill has been advised of the possibility of such damages.  In no event shall Scott Kevill be liable for any damages, regardless of the form of the claim. The person using the software bears all risk as to the quality and performance of the software.
  504.  
  505.  
  506. Contact Information
  507.  
  508. Email:
  509.     <scott@kagi.com>
  510.     <scott@www.curtin.edu.au>
  511.  
  512. Web sites:
  513.     QuakeFinder
  514.     <http://www.curtin.edu.au/~scott/quakefinder/>
  515.  
  516.     Quiver (the intuitive Macintosh Quake level editor)
  517.     <http://www.curtin.edu.au/~scott/quiver/>
  518.  
  519.     Scott’s MacQuake Utilities
  520.     <http://www.curtin.edu.au/~scott/macquake/>
  521.  
  522.     Scott’s Mac Software
  523.     <http://www.curtin.edu.au/~scott/software.html>
  524.  
  525. IRC:
  526.     Evill in #macquake on Effnet.
  527.  
  528. Hotline Nickname:
  529.     Evill
  530.